Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NCTools documentation update for 2023.02 #264

Merged
merged 11 commits into from
Dec 15, 2023
Merged

Conversation

ngs333
Copy link
Contributor

@ngs333 ngs333 commented Dec 8, 2023

This PR updates the NCTools documentation by:

  1. Slight improvements to the README.md file.
  2. Updating the example "extreme frgrid" runscript to work on Gaea C5, and to run 5x faster that the
    prior one with similar amount of resources.
  3. provides an outline one part of one fregrid remapping algorithm to highlight the use of some options (e.g.
    cell_measures and cell_methods)
  4. Provides a table/document of certain NCTools CI tests that are essentially showing a "workflow" and can provide the
    users with some context.
  5. Adds a document concerning a trick for additional testing.

(NOTE:
Some files are being saved in the docs directory as pdf files. The source files for these are these google docs
which should have been shared with all:
https://docs.google.com/document/d/1bHB-_6HKofVTOT0xaX1MRZL_fUKKCxiuOL--zuDyymk
https://docs.google.com/document/d/17IgBJksVO297WAdMP_NRGh5i63BOADbUJ2U6HsE45NI/
https://docs.google.com/document/d/18a8_10_Y_3BGiPoVyYvbKkEUaj62KHsg9EBnWzQOMq0
)

clarifying its purpose on the "extreme fregrid" doc.
@ngs333
Copy link
Contributor Author

ngs333 commented Dec 13, 2023

As per idea of @ceblanton , modified the README.md to mention fregrid_parallel, and also updated the
"extreme fregrid" documentation to clarify the purpose of fregrid_parallel,

README.md Outdated Show resolved Hide resolved
docs/extreme_fregrid_sample_runscript.txt Show resolved Hide resolved
@ngs333 ngs333 requested a review from bensonr December 14, 2023 22:50
@ceblanton ceblanton merged commit aa6b860 into NOAA-GFDL:master Dec 15, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants